docs: document embedding and pruning for private packages [RED-1310] - #754

Linear: RED-1310

Adds Private Packages and Internal Registries (detect/synthetic-monitoring/playwright-checks/private-packages-and-internal-registries), next to Custom Dependencies in the Playwright Check Suites nav. It documents the CLI options for projects whose private packages come from a registry Checkly runners can't reach, none of which were documented before:

• bundle.packages.embed: ship private package tarballs inside the code bundle. Covers entry syntax, validation, credentials (needed only where the CLI runs), version pins, the 30 MB compressed code bundle limit, its error, and that Enterprise plans can raise it to 100 MB, and how dependencies of dependencies are handled.
• Automatic lockfile pruning, plus CHECKLY_LOCKFILE_PRUNE and CHECKLY_LOCKFILE_PRUNE_TIMEOUT.
• bundle.packages.prune: remove dependencies from the bundled package.json files, including member-scoped remove/keep, using pruning to speed up installs, and keeping packages the install itself needs (such as typescript for lifecycle scripts).
• runner.registries: route the runner's install to registries it can reach.

Each config snippet comes with an explanation of what it does. An Examples section walks through a pnpm monorepo with an internal registry and a private scope behind a VPN-only mirror.

Custom Dependencies now matches current CLI behaviour:

• .npmrc files are bundled automatically, so the checks.include step is gone. The page warns that bundled .npmrc tokens are uploaded, and drops the hard-coded token examples.
• The Artifactory example is split into a registry= line and a registry-scoped token, so the token is no longer part of the registry URL.
• bun is listed as a supported package manager.
• The dependency cache section describes the current invalidation inputs and documents runner.cache.install.version and --refresh-cache.

constructs/project.mdx gets bundle and runner rows that link to the new sections.

Depends on

The page describes behaviour after these changes. Merge this after all of them have shipped:

• RED-1312 (CLI): an embed pattern skips pnpm workspace members silently.
• RED-1313 (runner): embedded packages are served from the code bundle alone and never go through routing rules. A pinned embed entry must cover every lockfile version of the package.
• RED-1315 (CLI): checkly test and checkly deploy warn when an embed entry leaves lockfile versions of a package unembedded.
• RED-1316 (backend): an account's code bundle limit can be raised from 30 MB to 100 MB (offered on Enterprise plans).

Affected Components

• Content & Marketing
• Pricing
• Test
• Docs
• Learn
• Other

Notes for the Reviewer

• The pages describe the latest CLI only, without per-version notes.
• Behaviour claims were checked against the CLI and runner source and reproduced with checkly@10.0.0. Every checkly.config.ts example type-checks against it. The embed, prune and dependencies-of-dependencies behaviour was run on pnpm workspaces built like the examples.
• The Yarn Berry note ("looks them up in your registry's package metadata each time it bundles your checks") describes current CLI behaviour. RED-1311 tracks caching that lookup.
• The "Yarn workspaces remain unsupported" sentence in Custom Dependencies is unchanged. The CLI discovers Yarn workspaces, but runner support couldn't be confirmed.

Other changes

• The PlaywrightCheck construct examples no longer add .npmrc to include.

🤖 Generated with Claude Code